From f8acf4e90331c690d6e89098caab080913fe58a2 Mon Sep 17 00:00:00 2001 From: Alex Crichton Date: Thu, 23 Oct 2014 18:20:08 -0700 Subject: [PATCH] Document the new manifest keys --- Cargo.lock | 8 ++++---- src/doc/manifest.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 4 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 9c9fe781a..bda1d52b0 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -5,7 +5,7 @@ dependencies = [ "curl 0.0.1 (git+https://github.com/alexcrichton/curl-rust?ref=bundle#36b015de91daf6310227cec04ef30acf5929dfb6)", "docopt 0.6.5 (git+https://github.com/docopt/docopt.rs#1c9a63e0362848570f7c503f8891770ebf2d1eab)", "flate2 0.0.1 (git+https://github.com/alexcrichton/flate2-rs#68971ae77a523c7ec3f19b4bcd195f76291ea390)", - "git2 0.0.1 (git+https://github.com/alexcrichton/git2-rs#81cc81ac8daa4fdfc78d75385bb938425a632dcb)", + "git2 0.0.1 (git+https://github.com/alexcrichton/git2-rs#7d7fba10893590793ae88c8fc6ab2aeffcb8f10b)", "glob 0.0.1 (git+https://github.com/rust-lang/glob#469a6bc1a0fc289ab220170e691cffbc01dcf1e6)", "hamcrest 0.1.0 (git+https://github.com/carllerche/hamcrest-rust.git#7d46e76514ac606530dfb0e93270fffcf64ca76d)", "registry 0.0.1-pre", @@ -48,9 +48,9 @@ source = "git+https://github.com/alexcrichton/flate2-rs#68971ae77a523c7ec3f19b4b [[package]] name = "git2" version = "0.0.1" -source = "git+https://github.com/alexcrichton/git2-rs#81cc81ac8daa4fdfc78d75385bb938425a632dcb" +source = "git+https://github.com/alexcrichton/git2-rs#7d7fba10893590793ae88c8fc6ab2aeffcb8f10b" dependencies = [ - "libgit2 0.0.1 (git+https://github.com/alexcrichton/git2-rs#81cc81ac8daa4fdfc78d75385bb938425a632dcb)", + "libgit2 0.0.1 (git+https://github.com/alexcrichton/git2-rs#7d7fba10893590793ae88c8fc6ab2aeffcb8f10b)", "url 0.1.0 (git+https://github.com/servo/rust-url#7f1991d847fb8cf8648def2ff121bae90b89131f)", ] @@ -67,7 +67,7 @@ source = "git+https://github.com/carllerche/hamcrest-rust.git#7d46e76514ac606530 [[package]] name = "libgit2" version = "0.0.1" -source = "git+https://github.com/alexcrichton/git2-rs#81cc81ac8daa4fdfc78d75385bb938425a632dcb" +source = "git+https://github.com/alexcrichton/git2-rs#7d7fba10893590793ae88c8fc6ab2aeffcb8f10b" dependencies = [ "libssh2-static-sys 0.0.1 (git+https://github.com/alexcrichton/libssh2-static-sys#80e71a3021618eb05656c58fb7c5ef5f12bc747f)", "link-config 0.0.1 (git+https://github.com/alexcrichton/link-config#0202cc8aa74a7b0bdbaef4eef368d0bc80f63691)", diff --git a/src/doc/manifest.md b/src/doc/manifest.md index 9d9236616..60905b86c 100644 --- a/src/doc/manifest.md +++ b/src/doc/manifest.md @@ -64,6 +64,39 @@ the VCS's ignore settings (`.gitignore` for git for example). exclude = ["build/**/*.o", "doc/**/*.html"] ``` +## Package metadata + +There are a number of optional metadata fields also accepted under the +`[package]` section: + +```toml +[package] +# ... + +# A short blurb about the package. This is not rendered in any format when +# uploaded to registries. +description = "..." + +# These URLs point to more information about the repository +documentation = "..." +homepage = "..." +repository = "..." + +# This points to a file in the repository (relative to this Cargo.toml). The +# contents of this file are stored and indexed in the registry. +readme = "..." + +# This is a small list of keywords used to categorize and search for this +# package. +keywords = ["...", "..."] + +# This is a string description of the license for this package. Currently +# the registry will validate the license provided against a whitelist of known +# licenses. +license = "..." +``` + + # The `[dependencies.*]` Sections You list dependencies using `[dependencies.]`. For example, if you -- 2.30.2